Eight Additional layout renders for NLog.Web #784

bakgerman · 2022-06-01T22:15:11Z

Eight additional layout renders

Client certificate

Remote Port
Local Address
Local Port

Is Web socket request
Web socket requested protocols

Response Content Type
Response Headers

Response Cookies will be separate PR since that require add of Microsoft.AspNetCore.Http.Extensions NuGet package.

codecov-commenter · 2022-06-01T22:18:14Z

Codecov Report

Merging #784 (b706802) into master (55a7fca) will increase coverage by 4%.
The diff coverage is 76%.

@@          Coverage Diff           @@
##           master   #784    +/-   ##
======================================
+ Coverage      63%    67%    +4%     
======================================
  Files          48     58    +10     
  Lines         790    909   +119     
  Branches      196    226    +30     
======================================
+ Hits          498    606   +108     
+ Misses        223    212    -11     
- Partials       69     91    +22

Impacted Files	Coverage Δ
...rs/AspNetRequestClientCertificateLayoutRenderer.cs	`50% <50%> (ø)`
...enderers/AspNetRequestIsWebSocketLayoutRenderer.cs	`60% <60%> (ø)`
...equestWebSocketNegotiatedProtocolLayoutRenderer.cs	`60% <60%> (ø)`
...outRenderers/AspNetRequestLocalIpLayoutRenderer.cs	`67% <67%> (ø)`
...tRenderers/AspNetRequestLocalPortLayoutRenderer.cs	`67% <67%> (ø)`
...Renderers/AspNetRequestRemotePortLayoutRenderer.cs	`67% <67%> (ø)`
...nderers/AspNetResponseContentTypeLayoutRenderer.cs	`71% <71%> (ø)`
...utRenderers/AspNetResponseHeadersLayoutRenderer.cs	`78% <78%> (ø)`
...equestWebSocketRequestedProtocolsLayoutRenderer.cs	`80% <80%> (ø)`
...outRenderers/AspNetLayoutMultiValueRendererBase.cs	`87% <92%> (+2%)`	⬆️
... and 3 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 55a7fca...b706802. Read the comment docs.

bakgerman · 2022-06-01T22:21:49Z

I see, I need to fix 4 code smell, I will do that soon.

This reverts commit 72f70c6.

src/Shared/LayoutRenderers/AspNetRequestClientCertificateLayoutRenderer.cs

src/Shared/LayoutRenderers/AspNetLayoutMultiValueRendererBase.cs

src/Shared/LayoutRenderers/AspNetRequestWebSocketNegotiatedProtocolLayoutRenderer.cs

src/Shared/LayoutRenderers/AspNetLayoutMultiValueRendererBase.cs

…Framework and Core.

sonarqubecloud · 2022-06-03T18:15:57Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

88.5% Coverage
0.0% Duplication

snakefoot · 2022-06-04T10:27:56Z

Think it looks great, and excellent unit-test coverage.

snakefoot · 2022-06-04T11:42:25Z

Created #786 that changes AspNetRequestIsWebSocketLayoutRenderer from "true" / "false" to "1" / "0"

snakefoot · 2022-06-04T12:07:26Z

Created wiki-pages:

bakgerman · 2022-06-04T17:01:01Z

Think it looks great, and excellent unit-test coverage.

You are welcome!

snakefoot · 2022-06-06T09:51:15Z

I guess if we should follow semver, then with all these new features/funcationality, then next version should be v5.1 and not just v5.0.1

bakgerman · 2022-06-06T15:45:30Z

I guess if we should follow semver, then with all these new features/funcationality, then next version should be v5.1 and not just v5.0.1

I agree. With response cookie PR and the earlier PR that is a total of 9 new layout renders.

I am going to start work on a 'public bool Verbose' property for response cookie layout renderer that will also log the domain, path, expire, etc of the cookie. For the Json output format, i will do just with StringBuilder.Append() and not use System.text.Json or Newtonsoft.Json.

Then I will add the response body to the request body middleware. This one I already have a version working for 18 months at my employer.

Then I will try to do HttpModule version of request and response body logging. I find a legacy .NET 4.8 ASPX application at my employer I can test this with.

After that I may look at up-for-grab features at NLog.

snakefoot · 2022-06-06T15:50:45Z

I will add the response body to the request body middleware. This one I already have a version working for 18 months at my employer.

Then I will not press the release-button just yet.

I will try to do HttpModule version of request and response body logging. I find a legacy .NET 4.8 ASPX application at my employer I can test this with.

Notice #785 have introduced a basic HttpModule for ASP.NET Classic (NLogRequestPostedBodyModule)

snakefoot · 2022-07-18T20:19:27Z

Updated https://nlog-project.org/config/?tab=layout-renderers with the new LayoutRenderers for NLog.Web.AspNetCore v5.1

snakefoot · 2022-07-18T20:23:38Z

Updated https://nlog-project.org/documentation/v5.0.0/html/N_NLog_Web_LayoutRenderers.htm with the new LayoutRenderers for NLog.Web.AspNetCore v5.1

Burak Akgerman added 2 commits June 1, 2022 17:25

Eight Additional Layout Renderers

82411ab

WebSocketRequestedProtocol Layout Renderer

da60d63

pull-request-size bot added the size/XXL label Jun 1, 2022

Burak Akgerman added 6 commits June 1, 2022 18:29

Fix 3 code smells

4899155

Fix another code smell

72f70c6

Revert "Fix another code smell"

2bc8e9f

This reverts commit 72f70c6.

remove duplicated code

6699236

Fix code smell

b706802

Codes Improvements for Web Socket Renderers

581ac25

snakefoot reviewed Jun 3, 2022

View reviewed changes

src/Shared/LayoutRenderers/AspNetRequestClientCertificateLayoutRenderer.cs Outdated Show resolved Hide resolved

snakefoot reviewed Jun 3, 2022

View reviewed changes

src/Shared/LayoutRenderers/AspNetLayoutMultiValueRendererBase.cs Outdated Show resolved Hide resolved

snakefoot reviewed Jun 3, 2022

View reviewed changes

src/Shared/LayoutRenderers/AspNetRequestWebSocketNegotiatedProtocolLayoutRenderer.cs Outdated Show resolved Hide resolved

snakefoot reviewed Jun 3, 2022

View reviewed changes

src/Shared/LayoutRenderers/AspNetLayoutMultiValueRendererBase.cs Outdated Show resolved Hide resolved

Burak Akgerman added 4 commits June 3, 2022 13:55

Fix missing dash in layout renderer attribute name

3c98f34

Remove regions and rename methods to make more sense

428f150

Remove WebSocketNegotiatedProtocol until I can make it work for both …

1412158

…Framework and Core.

Forgot to remove the associated unit test class.

3d78e08

bakgerman changed the title ~~Nine Additional layout renders for NLog.Web~~ Eight Additional layout renders for NLog.Web Jun 3, 2022

snakefoot added the feature label Jun 4, 2022

snakefoot added this to the 5.0.1 milestone Jun 4, 2022

snakefoot merged commit 0a06ef8 into NLog:master Jun 4, 2022

snakefoot mentioned this pull request Jun 4, 2022

AspNetRequestIsWebSocketLayoutRenderer - Changed from true / false to 1 / 0 #786

Merged

snakefoot added ASP.NET 4 ASP.NET MVC Classic ASP.NET Core ASP.NET Core - all versions labels Jun 6, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Eight Additional layout renders for NLog.Web #784

Eight Additional layout renders for NLog.Web #784

bakgerman commented Jun 1, 2022 •

edited

Loading

codecov-commenter commented Jun 1, 2022 •

edited

Loading

bakgerman commented Jun 1, 2022

sonarqubecloud bot commented Jun 3, 2022

snakefoot commented Jun 4, 2022

snakefoot commented Jun 4, 2022

snakefoot commented Jun 4, 2022 •

edited

Loading

bakgerman commented Jun 4, 2022

snakefoot commented Jun 6, 2022

bakgerman commented Jun 6, 2022

snakefoot commented Jun 6, 2022 •

edited

Loading

snakefoot commented Jul 18, 2022

snakefoot commented Jul 18, 2022

Eight Additional layout renders for NLog.Web #784

Eight Additional layout renders for NLog.Web #784

Conversation

bakgerman commented Jun 1, 2022 • edited Loading

codecov-commenter commented Jun 1, 2022 • edited Loading

Codecov Report

bakgerman commented Jun 1, 2022

sonarqubecloud bot commented Jun 3, 2022

snakefoot commented Jun 4, 2022

snakefoot commented Jun 4, 2022

snakefoot commented Jun 4, 2022 • edited Loading

bakgerman commented Jun 4, 2022

snakefoot commented Jun 6, 2022

bakgerman commented Jun 6, 2022

snakefoot commented Jun 6, 2022 • edited Loading

snakefoot commented Jul 18, 2022

snakefoot commented Jul 18, 2022

bakgerman commented Jun 1, 2022 •

edited

Loading

codecov-commenter commented Jun 1, 2022 •

edited

Loading

snakefoot commented Jun 4, 2022 •

edited

Loading

snakefoot commented Jun 6, 2022 •

edited

Loading